Skip to main content

DescribeMachines

Description

No description for this api.

Request Method

POST

Request Path

/apsara/route/aegis/DescribeMachines

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
regionIdBODYstringYesNo sample value for this parameter.region id
TagIdListBODYstringNoNo sample value for this parameter.host asset tag ID.
versionBODYstringNo2016-01-01version of api
GroupIdBODYlongNoNo sample value for this parameter.asset group ID.
RemarkBODYstringNoNo sample value for this parameter.host asset IP or instance name.

Return data

NameTypeSample valueDescription
InstanceNamestringno demo valuehost instance name.
Uuidstringno demo valuehost asset UUID.
RequestIdstringno demo valuerequest ID.
OSstringno demo valueoperating system type.
Ipstringno demo valuehost asset IP. description gives priority to the public IP of the host. if the host does not have a public IP, the private IP is displayed.
Countintegerno demo valuereturns the total number of records.
Machinesarrayno demo valuehost instance list information, see the following parameter description for specific sub-items.
GroupIdintegerno demo valueasset group ID.

Example

Successful Response example

{
"InstanceName":"no demo value",
"Uuid":"no demo value",
"RequestId":"no demo value",
"OS":"no demo value",
"Ip":"no demo value",
"Count":"no demo value",
"Machines":"no demo value",
"GroupId":"no demo value"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}